home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
remote
/
ratp23.zip
/
RATOP.DOC
< prev
next >
Wrap
Text File
|
1991-12-21
|
11KB
|
318 lines
------------------------------------------------------------------------------
RaTop v2.3
RemoteAccess Top Users Bulletin Generator
Copyright (C) 1990-91 Foxtrot Software
All Rights Reserved.
This is a shareware program, this program is not to be sold or modified
in any way. You are free to copy and distribute RaTop as long as:
a. No fee is charged for use of the program or the documentation.
A fee may be charged for copying or distibution of this software
and documentation for others not to exceed US $10.00.
b. It is not modified or reverse engineered in any way.
c. You distribute this software along with all documentation and
registration forms unmodified.
The Author hereby disclaims all warranties relating to this software,
whether expressed or implied, including without limitation any implied
warranties of merchantability or fitness for a particular purpose. The
author will not be liable for any special, incidental, consequenctial,
indirect or simular damages due to loss of data or any other reason. The
user of this software bears all risk as to the quality and performance
of this software.
-------------------Now that we have that out of the way-----------------------
If you have any comments or suggestions for improvement of this software,
you can contact me at Info-Center BBS, data: (914)567-1814, 24 hours a
day or leave Net-Mail @Fidonet 1:272/26, @Magnet 100:900/39.
If you like this software, and decide to keep it on your system, then
please register your copy. Registration is US $8.00. Please help support
the shareware concept and development of even more quality utilities.
Thank you for your support.
------------------------------------------------------------------------------
1. Introduction.
RaTop is a utility that will allow the Sysop of a RA BBS system to
produce a TOP Users Bulletin that contains the TOP Callers, TOP
Downloaders and TOP Uploaders by name and how many times they called,
bytes downloaded and bytes Uploaded on your system.
A number of features allow you to create custom Top User bulletins for
your system. These features are:
a) Full Ansi Color support.
b) Ability to limit the numbers of users inluded in the bulletin.
Range is from 10-64000.
c) Control who will show up by Security Levels.
d) Control who will show up by Security Flags.
e) Control who will show up by Group Number.
* f) Control who will show up by 'NoList' switch.
g) Choice of Sysop or no Sysop to be included.
* h) Use Handles instead of real names in bulletins.
i) Use of an alternate control file so that multiple bulletins
may be created and tailored to different user parameters/
j) Ascii & Ansi bulletins are created.
* New with v2.3.
RaTop uses the environment variable RA= to find your System Files.
This is required because not all RA systems place their USERS.BBS along
with the rest of the system files. The CONFIG.RA file is used to verify
your key and to find the pathnames to your USERS.BBS file. If the
environment variable is not set on your system, then RaTop must be run in
the same directory where the System files are located.
*Note: Please make sure that all your PATHS that you have specified
in your system configuration are FULL Paths to all your RA
System files and Message Base Files. For example, if you used
\RA\ or \RA\MESSAGES\ to specify the paths to these areas, then
RATop must be run from the same Disk Drive as your RA BBS is
set up on. Since no Drive is specified here, RATop does not
check which drive it is currently on so the required files for
operation may not be found.
You can set the variable by using the DOS Command SET RA=C:\RA in your
autoexec.bat startup file. Please refer to the RA documentation for
further information on regarding setup of System Paths and the use of
the RA environment variable.
The bulletins created by RATop are usually placed in same directory as
all other text files that you use, but this can be overridden in the
RATop control file.
This version of RaTop is for use with Remote Access V 1.0 and later
releases.
2. Setup.
The following outlines what commands to in the RATOP.CTL control
file and COLORS available to adjust to your liking.
a. An Editor that will create text files, such as EDLIN, GALAXY,
or any Editor that will allow CR/LF combinations at the end of each
line has to be used. Create the RATOP.CTL file in your RA BBS
directory where your Users.BBS and your CONFIG.RA files are if
the RA environment variable is set, the directory you will be
running RaTop from. RATop has deafults for all keywords listed
below. When you wish to have a keyword disabled and the default
assumed, then place a semi-colon in front of that keyword or leave
it out entirely. Enter the following information:
;
; Path - Full pathname of where you want the bulletin put. No extension
; is placed on this pathname. If this command isn't present, then
; RaTop will assume BULLET01 only as the filename and place the
; bulletins in your current directory.
;
Path D:\RA\Txtfiles\Bullet01
;
; Title - The Title you wish to have at the heading of the bulletin.
; This can be anything you desire as long as it is 70 characters
; or less. If this command isn't present, then RaTop will assume:
; 'Noname BBS from Anytown, USA'
;
Title Info-Center BBS * Top Users Report
;
; Frame - This is the color you want the frame of the bulletin to be.
;
Frame 3
;
; Title1 - This is the color you want the Title above to be.
;
Title1 15
;
; Title2 - This is the color you want the Bulletin Heading to be.
; The bulletin heading is:
; 'C A L L E R S D O W N L O A D E R S U L O A D E R S'
;
Title2 10
;
; Users - This is the color you want the users names to be.
;
Users 14
;
; Group - Include this Keyword only if you want certain user groups to
; included in the bulletin. Valid Group numbers are 0-255.
; Default is to include ALL groups in the bulletin.
;
Group 0
;
; ShowHidden - This keyword allows RATop to use users names/handles in the
; Bulletins created. Default is not to include these users
; in the list.
;
ShowHidden
;
; HandlesOnly - This keyword will allow RATop to use only Handles instead
; real names in the bulletins created. Default is to use
; real names.
;
HandlesOnly
;
; Background - This is the color you want the bulletin background to be.
;
Background 0
;
; Security - The lowest security level a user has to have before being included
; in the bulletin. Max is 64000.
;
SecurityLvl 5
;
; SecFlags - This works exactly like the flags work for RemoteAccess.
;
SecFlags -------- -------- -------- --------
;
b. Available Colors Codes:
________
0 Black \
1 Blue \
2 Green \ BackGround or
3 Cyan ---------------
4 Red / ForeGround
5 Magenta /
6 Brown /
7 LightGray ___/
_______
8 Gray \
9 LightBlue \
10 LightGreen \ Foreground Only
11 LightCyan ------------------
12 LightRed /
13 LightMagenta /
14 Yellow /
15 White ______/
c. How to run RaTop:
Usage: RaTop [-?] [-S] [{-U n}] [-?] [{-F CtlFile}]
RaTop can be executed with any or none of the following arguments:
[-S] - will tell RaTop to include the SysOp's name and
number of Calls, Downloads and Uploads. Default is not
to include the SysOp in the Bulletin.
[-U n] - will tell RaTop how many Users you wish to include
in the Bulletin. Default is The Top 20 Users.
Valid numbers are from 10 - 64000.
[-?] - will tell RaTop to display command line help. If
this argument is to be used, then it must be the only
one used on the command line to recieve help.
[-F CtlFile] - will tell RaTop to use an alternate Control file
to process. This would allow you to create numerous
bulletins using different security/flags settings.
d. All that is needed now is, you to make sure that you have
RATOP.CTL in your current directory and then execute RATOP.EXE
it in that directory. RATOP.EXE defaults to USERS.BBS and is
not configurable by you.
4. Closing.
I hope this little utility will help enhance your RA BBS as it
has mine. I had fun writing it anyway.
Other quality software available from me for SysOps:
Magic Name Description
RAFBSTAT Creates a bulletin with stats on all your files areas for
Remote Access v 1.0.
QUIKTOP Creates a Top Users bulletin for QuickBBS 2.64.
OPUSTOP Creates a Top Users bulletin for OPUS CBCS 1.1x.
RATOP Creates a Top Users bulletin for RemoteAccess 1.01.
PROBLEMS:
Please notify me immediately if you have any problems or
suggestions about this program. Enhancements are being incorporated
all the time and your input is more vital to this process than you
think. You may write me, send Net-Mail or logon at the following address:
Byron Copeland (Sysop) Info-Center BBS (formerly The
11 Y Street Foxtrot BBS, 1:360/11)
New Windsor, NY 12553 (914) 567-1814 @Fidonet 1:272/26
24 hours, Every day!
Authorized Distibution sites for Foxtrot Software:
Info-Center BBS New Windsor, NY (914) 567-1814
The Outlaw BBS Kennesaw, GA (404) 590-1969
Enjoy and thank you for your support.
- End -